

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">

<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>The rstGeneration module &mdash; pyamp v1.2 documentation</title>
    <link rel="stylesheet" href="../_static/default.css" type="text/css" />
    <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '../',
        VERSION:     '1.2',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="../_static/jquery.js"></script>
    <script type="text/javascript" src="../_static/underscore.js"></script>
    <script type="text/javascript" src="../_static/doctools.js"></script>
    <link rel="top" title="pyamp v1.2 documentation" href="../index.html" />
    <link rel="up" title="The documentation module" href="mod_pyamp_documentation.html" />
    <link rel="next" title="The logging module" href="mod_pyamp_logging.html" />
    <link rel="prev" title="The documentation module" href="mod_pyamp_documentation.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_logging.html" title="The logging module"
             accesskey="N">next</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_documentation.html" title="The documentation module"
             accesskey="P">previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_documentation.html" accesskey="U">The documentation module</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-pyamp.documentation.rstGeneration">
<span id="the-rstgeneration-module"></span><h1>The rstGeneration module<a class="headerlink" href="#module-pyamp.documentation.rstGeneration" title="Permalink to this headline">¶</a></h1>
<p>The rstGeneration module contains classes and functions which provide
the ability to generate a single reStructured text formatted file for
each of the modules contained within a main Python project.</p>
<div class="section" id="the-rstoptions-class">
<h2>The RstOptions class<a class="headerlink" href="#the-rstoptions-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-56fac1a3427ec01ecc4a0d4d20719c6da7b1a002.png" alt="Inheritance diagram of pyamp.documentation.rstGeneration.RstOptions" usemap="#inheritancee7b7d278db" class="inheritance"/>
<map id="inheritancee7b7d278db" name="inheritancee7b7d278db">
<area shape="rect" href="#pyamp.documentation.rstGeneration.RstOptions" title="pyamp.documentation.rstGeneration.RstOptions" alt="" coords="5,7,336,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.documentation.rstGeneration.RstOptions">
<em class="property">class </em><tt class="descclassname">pyamp.documentation.rstGeneration.</tt><tt class="descname">RstOptions</tt><big>(</big><em>inheritance=True</em>, <em>overwrite=False</em>, <em>extension='.rst'</em>, <em>ignoredModules=None</em>, <em>modifiedDirectory='_modified'</em><big>)</big><a class="reference internal" href="../_modules/pyamp/documentation/rstGeneration.html#RstOptions"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.documentation.rstGeneration.RstOptions" title="Permalink to this definition">¶</a></dt>
<dd><p>The RstOptions class encapsulates all the options that can be passed
to the RST generation class to configure the generated output.</p>
<ul>
<li><p class="first">inheritance &#8211; True to include inheritance diagrams for each class</p>
</li>
<li><p class="first">overwrite &#8211; True to overwrite existing files</p>
</li>
<li><p class="first">extension &#8211; The extension to use for generated files</p>
</li>
<li><dl class="first docutils">
<dt>ingoreModules &#8211; The list of modules to ignore (i.e., no RST files</dt>
<dd><p class="first last">will be created for these modules)</p>
</dd>
</dl>
</li>
<li><p class="first">modifiedDirectory &#8211; The modified directory</p>
</li>
</ul>
</dd></dl>

</div>
<div class="section" id="the-rstmoduledirectory-class">
<h2>The RstModuleDirectory class<a class="headerlink" href="#the-rstmoduledirectory-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-179d293e30f040be66ee2ed9c9b1047003b1a27f.png" alt="Inheritance diagram of pyamp.documentation.rstGeneration.RstModuleDirectory" usemap="#inheritance0a76d83f76" class="inheritance"/>
<map id="inheritance0a76d83f76" name="inheritance0a76d83f76">
<area shape="rect" href="#pyamp.documentation.rstGeneration.RstBase" title="pyamp.documentation.rstGeneration.RstBase" alt="" coords="41,84,356,111"/>
<area shape="rect" href="#pyamp.documentation.rstGeneration.RstModuleDirectory" title="pyamp.documentation.rstGeneration.RstModuleDirectory" alt="" coords="5,161,392,188"/>
<area shape="rect" href="pyamp_logging_loggable.html#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="81,7,316,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.documentation.rstGeneration.RstModuleDirectory">
<em class="property">class </em><tt class="descclassname">pyamp.documentation.rstGeneration.</tt><tt class="descname">RstModuleDirectory</tt><big>(</big><em>moduleName</em>, <em>subFiles</em>, <em>subDirectories</em>, <em>logData=None</em><big>)</big><a class="reference internal" href="../_modules/pyamp/documentation/rstGeneration.html#RstModuleDirectory"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.documentation.rstGeneration.RstModuleDirectory" title="Permalink to this definition">¶</a></dt>
<dd><p>The RstModuleDirectory encapsulates the functionality of writing a
file in reStructured text format for a given Python module which is
a directory containing one or more Python sub-modules.</p>
<ul class="simple">
<li>moduleName &#8211; The name of the module which contains this module</li>
<li>subFiles &#8211; The list of sub-file modules for this module</li>
<li>subDirectories &#8211; The list of sub-directory module for this module</li>
<li>&#8211; The LogData object</li>
</ul>
</dd></dl>

</div>
<div class="section" id="the-rstbase-class">
<h2>The RstBase class<a class="headerlink" href="#the-rstbase-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-04abfda6a123a693d1ef525ca89dd4e53f2874c9.png" alt="Inheritance diagram of pyamp.documentation.rstGeneration.RstBase" usemap="#inheritancebe17cdfff4" class="inheritance"/>
<map id="inheritancebe17cdfff4" name="inheritancebe17cdfff4">
<area shape="rect" href="pyamp_logging_loggable.html#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="45,7,280,33"/>
<area shape="rect" href="#pyamp.documentation.rstGeneration.RstBase" title="pyamp.documentation.rstGeneration.RstBase" alt="" coords="5,84,320,111"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.documentation.rstGeneration.RstBase">
<em class="property">class </em><tt class="descclassname">pyamp.documentation.rstGeneration.</tt><tt class="descname">RstBase</tt><big>(</big><em>moduleName</em>, <em>logData=None</em><big>)</big><a class="reference internal" href="../_modules/pyamp/documentation/rstGeneration.html#RstBase"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.documentation.rstGeneration.RstBase" title="Permalink to this definition">¶</a></dt>
<dd><p>The RstBase class provides the base functionality used to create
RstFiles based off of Python modules. It takes a module name and
provides the ability to write the output in reStructured text format.</p>
<ul class="simple">
<li>moduleName &#8211; The name of the module which contains this module</li>
<li>logData &#8211; The LogData object</li>
</ul>
<dl class="attribute">
<dt id="pyamp.documentation.rstGeneration.RstBase.contentFunctions">
<tt class="descname">contentFunctions</tt><a class="headerlink" href="#pyamp.documentation.rstGeneration.RstBase.contentFunctions" title="Permalink to this definition">¶</a></dt>
<dd><p>The contentFunctions property should be set to a list of class
function names. These functions will be called, in order, to return a list
of lines to add to the final generated file.</p>
<p>Each content function takes an <a class="reference internal" href="#pyamp.documentation.rstGeneration.RstOptions" title="pyamp.documentation.rstGeneration.RstOptions"><tt class="xref py py-class docutils literal"><span class="pre">RstOptions</span></tt></a> object as its only
parameter, and should return a list of strings.</p>
</dd></dl>

<dl class="method">
<dt id="pyamp.documentation.rstGeneration.RstBase.write">
<tt class="descname">write</tt><big>(</big><em>directory</em>, <em>options</em><big>)</big><a class="reference internal" href="../_modules/pyamp/documentation/rstGeneration.html#RstBase.write"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.documentation.rstGeneration.RstBase.write" title="Permalink to this definition">¶</a></dt>
<dd><p>Generate the reStructured text formatted file for this
Python module.</p>
<ul class="simple">
<li>directory &#8211; The output directory in which to write the file</li>
<li>options &#8211; The RstOptions to use when generating the file</li>
</ul>
</dd></dl>

</dd></dl>

</div>
<div class="section" id="the-rstmodule-class">
<h2>The RstModule class<a class="headerlink" href="#the-rstmodule-class" title="Permalink to this headline">¶</a></h2>
<p class="graphviz">
<img src="../_images/inheritance-9e109b0dbd8dce9db754cee2a82e47a40cca2e7c.png" alt="Inheritance diagram of pyamp.documentation.rstGeneration.RstModule" usemap="#inheritancee981abca90" class="inheritance"/>
<map id="inheritancee981abca90" name="inheritancee981abca90">
<area shape="rect" href="#pyamp.documentation.rstGeneration.RstBase" title="pyamp.documentation.rstGeneration.RstBase" alt="" coords="12,84,327,111"/>
<area shape="rect" href="#pyamp.documentation.rstGeneration.RstModule" title="pyamp.documentation.rstGeneration.RstModule" alt="" coords="5,161,333,188"/>
<area shape="rect" href="pyamp_logging_loggable.html#pyamp.logging.loggable.Loggable" title="pyamp.logging.loggable.Loggable" alt="" coords="52,7,287,33"/>
</map>
</p>
<dl class="class">
<dt id="pyamp.documentation.rstGeneration.RstModule">
<em class="property">class </em><tt class="descclassname">pyamp.documentation.rstGeneration.</tt><tt class="descname">RstModule</tt><big>(</big><em>moduleName</em>, <em>logData=None</em><big>)</big><a class="reference internal" href="../_modules/pyamp/documentation/rstGeneration.html#RstModule"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#pyamp.documentation.rstGeneration.RstModule" title="Permalink to this definition">¶</a></dt>
<dd><p>The RstModule class encapsulates the functionality of writing a
file in reStructured text format for a given Python module which is
a single Python file.</p>
<ul class="simple">
<li>moduleName &#8211; The name of the module which contains this module</li>
<li>logData &#8211; The LogData object</li>
</ul>
</dd></dl>

</div>
</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
  <h3><a href="../index.html">Table Of Contents</a></h3>
  <ul>
<li><a class="reference internal" href="#">The rstGeneration module</a><ul>
<li><a class="reference internal" href="#the-rstoptions-class">The RstOptions class</a></li>
<li><a class="reference internal" href="#the-rstmoduledirectory-class">The RstModuleDirectory class</a></li>
<li><a class="reference internal" href="#the-rstbase-class">The RstBase class</a></li>
<li><a class="reference internal" href="#the-rstmodule-class">The RstModule class</a></li>
</ul>
</li>
</ul>

  <h4>Previous topic</h4>
  <p class="topless"><a href="mod_pyamp_documentation.html"
                        title="previous chapter">The documentation module</a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="mod_pyamp_logging.html"
                        title="next chapter">The logging module</a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="../_sources/_generated/pyamp_documentation_rstGeneration.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="../search.html" method="get">
      <input type="text" name="q" size="18" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="../genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="../py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_logging.html" title="The logging module"
             >next</a> |</li>
        <li class="right" >
          <a href="mod_pyamp_documentation.html" title="The documentation module"
             >previous</a> |</li>
        <li><a href="../index.html">pyamp v1.2 documentation</a> &raquo;</li>
          <li><a href="mod_pyamp.html" >The pyamp module</a> &raquo;</li>
          <li><a href="mod_pyamp_documentation.html" >The documentation module</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, Brett Ponsler.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.0.1.
    </div>
  </body>
</html>